.. _CGameEffect Class:

==========================
CGameEffect Class
==========================

.. toctree::
   :maxdepth: 1

* :ref:`Overview<CGameEffect_Overview>`
* :ref:`Quick Reference<CGameEffect_QuickRef>`
* :ref:`Constructors<CGameEffect_Constructors>`
* :ref:`Methods<CGameEffect_Methods>`
* :ref:`Operators<CGameEffect_Operators>`

----

.. _CGameEffect_Overview:

Overview
---------------

.. note:: The **CGameEffect** class handles game effects

The structure used for this class is :ref:`CGameEffect<CGameEffect>`

----

.. _CGameEffect_QuickRef:

Quick Reference
---------------

+-------------------------------------------------------------------------------------------------------------------------------------+
| **Quick Ref**                                                                                                                       |
+-------------------------------------------------------------------------------------------------------------------------------------+
|                                                                                                                                     |
+-------------------------------------------------------------------------------------------------------------------------------------+


----

.. _CGameEffect_Constructors:

Constructors
---------------

+---------------------------------------------------------------+------------------------------------------------------+
| **Name**                                                      | **Description**                                      |
+---------------------------------------------------------------+------------------------------------------------------+
| :ref:`CGameEffect\:\:CGameEffect<CGameEffectCGameEffect>`     | Constructs a ``CGameEffect`` object                  |
+---------------------------------------------------------------+------------------------------------------------------+

.. _CGameEffectCGameEffect:

CGameEffect\:\:CGameEffect
^^^^^^^^^^^^^^^^^^^^^^^^^^

Constructs a ``CGameEffect`` object

::

   void CGameEffect::CGameEffect();

**Remarks**

Constructs a ``CGameEffect`` object


----

.. _CGameEffect_Methods:

Methods
---------------

+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **Name**                                                                    | **Description**                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:ApplyEffect<CGameEffectApplyEffect Function>`          |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:CheckAdd<CGameEffectCheckAdd>`                         |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:CheckSave<CGameEffectCheckSave>`                       |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:ClearItemEffect<CGameEffectClearItemEffect>`           |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:Copy<CGameEffectCopy>`                                 |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:CopyFromBase<CGameEffectCopyFromBase>`                 |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:DecodeEffect<CGameEffectDecodeEffect>`                 |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:DecodeEffectFromBase<CGameEffectDecodeEffectFromBase>` |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:DisplayString<CGameEffectDisplayString Function>`      |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:EqualClass<CGameEffectEqualClass>`                     |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:FireSpell<CGameEffectFireSpell>`                       |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:OnAdd<CGameEffectOnAdd>`                               |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:OnAddSpecific<CGameEffectOnAddSpecific>`               |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:OnLoad<CGameEffectOnLoad>`                             |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:OnRemove<CGameEffectOnRemove>`                         |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:PlaySound<CGameEffectPlaySound Function>`              |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:ResolveEffect<CGameEffectResolveEffect>`               |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:SetIdentified<CGameEffectSetIdentified>`               |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:UsesDice<CGameEffectUsesDice>`                         |                                                                                         |
+-----------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+


----

.. _CGameEffectApplyEffect Function:

CGameEffect\:\:ApplyEffect
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectCheckAdd:

CGameEffect\:\:CheckAdd
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectCheckSave:

CGameEffect\:\:CheckSave
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectClearItemEffect:

CGameEffect\:\:ClearItemEffect
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectCopy:

CGameEffect\:\:Copy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectCopyFromBase:

CGameEffect\:\:CopyFromBase
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectDecodeEffect:

CGameEffect\:\:DecodeEffect
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectDecodeEffectFromBase:

CGameEffect\:\:DecodeEffectFromBase
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectDisplayString Function:

CGameEffect\:\:DisplayString
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectEqualClass:

CGameEffect\:\:EqualClass
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectFireSpell:

CGameEffect\:\:FireSpell
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectOnAdd:

CGameEffect\:\:OnAdd
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectOnAddSpecific:

CGameEffect\:\:OnAddSpecific
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectOnLoad:

CGameEffect\:\:OnLoad
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectOnRemove:

CGameEffect\:\:OnRemove
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectPlaySound Function:

CGameEffect\:\:PlaySound
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectResolveEffect:

CGameEffect\:\:ResolveEffect
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectSetIdentified:

CGameEffect\:\:SetIdentified
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffectUsesDice:

CGameEffect\:\:UsesDice
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CGameEffect_Operators:

Operators
---------------

+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **Name**                                                 | **Description**                                                                         |
+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:operator=<CGameEffectOpEqu>`        |                                                                                         |
+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CGameEffect\:\:operator==<CGameEffectOpEquEqu>`    |                                                                                         |
+----------------------------------------------------------+-----------------------------------------------------------------------------------------+

.. _CGameEffectOpEqu:

CGameEffect\:\:operator=
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

 

**Remarks**



----

.. _CGameEffectOpEquEqu:

CGameEffect\:\:operator==
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

 

**Remarks**